Issues

/api/issues

The issue search interface is intended to be used to query the billing system for a list of issues for the used api_key. A list of issues is returned, formatted as JSON, with basic issues information including their unique id.

If you do not see an Issue you would like to use please contact dtteam@serverplus.com to have one added.

(HTTP GET)

These parameters are always included for an issue query:

api_key

Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name	Description
error	If there was an error this is a string describing the problem while searching. If this is set then any results are ignored. If there were no error this property does not need to be included, or can be set to null
issues	Required. An array of issue objects. If there were no matches then this should be an empty array. Properties for the issue object are explained below. If there were more than 200 records matched, only the first 200 records should be returned.
number_of_results	This is the number of records that matched the search results. If there were 200 or less matching records than this should be the same number as the length of the ‘customers’ array, however if there were more records matched than what was returns in the ‘issues’ array, this should indicate the total number of matches. This is used for notifying the end-user to use more search parameters to narrow down search results

Issue Object:

Element Name	Required	Description
id	yes	unique id of issue
category_id	yes	ID of the linked category
description	no	description of the issue
name	yes	name of the issue

Example Response JSON

An example response for a search on the URL:

https://tracker.serverplus.com/api/issues

JSON Response Body:

{
    "status": "ok",
    "data": [
        {
            "description": "",
            "category_id": 9,
            "id": 7774,
            "name": "New Equipment (MAC Auth, PPPoE, Static)"
        },
        {
            "description": "",
            "category_id": 8,
            "id": 7712,
            "name": "All Webmail Issues"
        },
        {
            "description": "",
            "category_id": 216,
            "id": 7772,
            "name": "Cannot connect with any devices -LAN "
        },
        {
            "description": "",
            "category_id": 326,
            "id": 8245,
            "name": "Cannot connect with any devices -LAN"
        }
    ],
    "error_fields": {},
    "status_message": null
}